コマンドラインモードでのエージェントの実行(DAIランエージェント)
DAIランエージェントは、ユーザーインターフェイスなしでコマンドラインから設定および実行することができます。
-
コマンドプロンプトからエージェントディレクトリに移動します。例えば:
- Windowsの場合:
C:\Program Files (x86)\eggplantDAIRunAgent\
- Macの場合:
/Applications
- Linuxの場合:(
eggplantDAIRunAgent
実行ファイルが抽出されたパス)
- Windowsの場合:
-
エージェント実行ファイルを実行し、適切な引数を追加します:
- Windowsの場合:
eggplantDAIRunAgent.exe [引数]
- Macの場合:
./eggplantDAIRunAgent [引数]
- Linuxの場合:
./eggplantDAIRunAgent [引数]
- Windowsの場合:
DAI Run Agentの実行例
DAI Run Agent にダウンロードした '.ini' ファイルへのパスを指定した場合。(DAI環境の作り方)。MacまたはLinuxベースのシステムのbashシェルターミナルで、EPFのGUIが必要ない場合は、次の引数を使用してDAI Run Agentを起動できます。
Mac/Linux:
./eggplantDAIRunAgent --ini-file "my envs/my_env.ini"
ファイルパスにスペースが含まれている場合は、引用符で囲む必要があります。
Windows:
“C:\Program Files (x86)\eggplantDAIRunAgent\eggplantDAIRunAgent.exe” --ini-file "C:\Users\{user}\my_env.ini"
コマンドライン引数
コマンドライン引数の完全なリスト、それらの使用方法、およびそれらの機能については、 '--help'フラグを使用してDAI Run Agentを起動できます。
Windows:
"C:\Program Files (x86)\eggplantDAIRunAgent\eggplantDAIRunAgent.exe" --help
Mac/Linux:
./eggplantDAIRunAgent --help
EPF コマンドライン引数と Run Agent 引数の受け渡し
Run Agent コマンドラインオプションとともに、エージェントが起動する EPF の実行オプションを指定できることに注意してください。EPF オプションを指定するには、Run Agent コマンドライン引数で 2 つのダッシュ ('--') を前に付けます。詳細については、EPF ドキュメントのコマンドラインからの実行 と Runscript コマンドラインオプション を参照してください。
DAI バージョン 7.3 以降では、DAI Run Agent コマンドで EPF 実行オプションを渡すことができます。
Run Agent コマンドで一般的に渡される EPF 引数の例を次に示します。
引数 | 環境変数 | 説明 |
---|---|---|
-licenser-host TEXT | ライセンサーホストを指定するためのEggplant Functional(EPF) 引数。 | |
-licenser-host TEXT | EPF 引数 Licenser パスワード。 |
EPF コマンドライン引数を使用した DAI Run Agent の実行の簡単な例
"C:\Program Files (x86)\eggplantDAIRunAgent\eggplantDAIRunAgent.exe” --ini-file "C:\Users\{user}\my_env.ini
ここで、EPF 引数の例は、2 つのダッシュが前に付いた '-LicenserHost' 引数です。
Run Agent のコマンドライン引数の表
以下は、サポートされているコマンドライン引数と対応する環境変数のリストです。
引数 | 環境変数 | 説明 |
---|---|---|
--ini-file FILE | DAI_AGENT_INI_FILE | DAI サーバーからダウンロードした環境設定 (.ini ) ファイルの場所。(.ini ) ファイルは、ダウンロードした ini ファイルの読み込み中にのみ作成されます。Default: Windows: C:Users{user}.eggplantDAI.ini (非表示としてマークされています。)Mac: ~/.eggplantDAI.ini Linux: ~/.eggplantDAI.ini |
--host-url TEXT | DAI_HOST_URL | 接続するEggplant DAIサーバー、例:https://server.company.com 。これは、環境設定(.ini )ファイルのhost_url にマップされます。--env-id と組み合わせて.ini ファイルの適切なセクションを選択するために使用します。指定されていない場合は、.iniファイルの最初のセクションを使用します。 |
--env-id INTEGER | DAI_EXEC_ENV_ID | DAIサーバー上の実行環境のID。--host-url と組み合わせて.ini ファイルの適切なセクションを選択するために使用します。指定されていない場合は、.iniファイルの最初のセクションを使用します。 |
--suite-root DIRECTORY | EGGDRIVE_SUITE_ROOT | ダウンロードしたSuiteの保存に使用したフォルダ。 Eggplant Functional(EPF)Suiteは、指定されたルートフォルダのサブフォルダとしてアップロードおよびダウンロードされます Default: Windows: C:\ProgramData\Eggplant\agent\Suites Mac: ~/Library/Application Support/agent/suites Linux: ~/.local/share/agent/suites |
--gui [True , False] | Eggplant FunctionalのUIを表示するかどうかを指定します。 Default: False | |
--drive-port INTEGER | EGGDRIVE_PORT | Eggplant FunctionalがeggDriveコマンドをリッスンするために使用するポート。 指定されていない場合は、ランダムに割り当てられた空きポートを使用します。 |
--log-level [INFO , DEBUG , WARNING , ERROR , TRACE] | ログ・レベル。INFO: は、Run Agent が期待どおりに動作していることを示す基本的なメッセージをログに記録します。DEBUG: は、通常、問題の診断に使用される詳細なメッセージを記録します。WARNING: は予期しないイベントや潜在的な問題をログに記録します。このレベルには、レベル ERROR で記録されたメッセージが含まれます。ERROR: Run Agent が正常に機能するために発生したエラーをログに記録します。TRACE: は、すべてのログレベルのメッセージをログに記録します。Default: INFO | |
--log-folder DIRECTORY | DAI_AGENT_LOG_FOLDER | ログファイルを保存するためのフォルダ。 Default: Windows: C:\ProgramData\Eggplant\agent\logs Mac: ~/Library/Logs/agent Linux: ~/.cache/agent/log |
--win-service [INSTALL , START , STOP , REMOVE , RESTART] | Windows サービスとして実行する、または既に実行するように設定されている DAI Run Agent の管理用。Windows サービスを制御するための適切なオプションを指定します。このParameterを --service-name Parameterと共に使用して、Run Agent Windows サービスの表示名を指定します。詳細については、Windows サービスとしてのエージェントの実行を参照してください。[デフォルトのサービス名(サービスをインストールするが、サービス名を指定しない場合):DAI Run Agent ] | |
--service-name TEXT | インストールされている DAI Run Agent Windows サービスの表示名。このParameterを--win-service Parameterとともに使用して、Run Agent の Windows サービスの表示名を指定します。[デフォルト: DAI Run Agent ] | |
--service-desc TEXT | DAI Run Agent Windows サービスの説明。このParameterを --win-service Parameterと一緒に使用して、サービスの説明を設定します。[デフォルト: Eggplant DAI Agent ] | |
--version | バージョンを表示します。 | |
--help | ヘルプメッセージを表示し、終了します。 |
DAI Run Agent の他の例
次に、さまざまなオペレーティングシステムで DAI Run Agent を実行する方法の例を、より詳細でオプションの引数を使用します。前の表は、DAI Run Agent で使用可能なすべての引数の一覧です。
.iniファイルに複数の環境セクションが含まれている場合は、--host-url
と--env-id
を指定する必要があります。
Windows:
“C:\Program Files (x86)\eggplantDAIRunAgent\eggplantDAIRunAgent.exe” --ini-file "C:\Users\{user}\my_env.ini" --log-level INFO --drive-port 5401
“C:\Program Files (x86)\eggplantDAIRunAgent\eggplantDAIRunAgent.exe” --ini-file "C:\Users\{user}\my_env.ini" --host-url https://server.company.com --env-id 1
Mac/Linux:
./eggplantDAIRunAgent --ini-file envs/my_env.ini --log-level INFO --drive-port 5401
./eggplantDAIRunAgent --ini-file envs/my_env.ini --host-url https://server.company.com --env-id 1
テスト設定実行のためのEggplant Functional停止および再起動設定
テスト設定を実行する際に、Eggplant Functional(EPF)を再起動するまでの実行時間や、ポーリング停止および再起動のための猶予期間を次の環境変数で設定できます。 詳細はテスト設定実行のためのEggplant Functional停止および再起動設定を参照してください。
環境変数 | デフォルト | 説明 |
---|---|---|
RESTART_EPF_AFTER_SECONDS | 1800 | テスト構成を実行する際、EPFが再起動する前にEPFが実行される間隔を秒単位で設定できます。この変数は、定義された時間が超過した場合に、現在のステップが終了し、次のステップに移る前に効果を発揮します。これは、DAI Run Agentで実行されるテスト構成にのみ適用されます。ライブ実行中は、EPFは再起動せずに連続して実行されます。テスト実行中にEPFを再起動させたくない場合は、このオプションを0(ゼロ)に設定して無効にすることができます。 |
EPF_QUIT_POLL_TIME_SECONDS | 20 | 再起動プロセス中にEPFが終了するための猶予期間。 |
EPF_RESTART_POLL_TIME_SECONDS | 120 | EPFが終了した後に起動するための猶予期間。EPF_RESTART_POLL_TIME_SECONDS にはEPF_QUIT_POLL_TIME_SECONDS は含まれません。 |